System APIs
This resource creates new RamBase event types without parameters.
| HTTP method | POST |
| URI | https://api.rambase.net/system/rambase-event-types |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 255, version 35 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Key
Required/mandatory field
Key of the Event Type. This key will be used to identify which event to fire.
Input must match the following regular expression pattern: ^([A-Za-z0-9_-]+)$
>{String}</Key>Description
Description of the Event Type
This field is optional.
>{String}</Description>AllowWebhooks
If the Event Type can be used to create webhooks
Default value: False
This field is optional.
>{Boolean}</AllowWebhooks>AllowAutomatedFlows
Whether this event type can be used in an automated flow.
Default value: False
This field is optional.
>{Boolean}</AllowAutomatedFlows>Name
Required/mandatory field
Name of the rambase event type. This should be more human readable than eventtype.
>{String}</Name>Namespace
Namespace of the rambase event type
This field is optional.
>{String}</Namespace>ObjectDetailsUri
API location for where to find more information about the object this event occurred for. May contains placeholders from with reference to parameter names. The parameter names are case sensitive.
This field is optional.
>{String}</ObjectDetailsUri>Key
Required/mandatory field
Key of the Event Type. This key will be used to identify which event to fire.
Input must match the following regular expression pattern: ^([A-Za-z0-9_-]+)$
": "{String}",Description
Description of the Event Type
This field is optional.
": "{String}",AllowWebhooks
If the Event Type can be used to create webhooks
Default value: False
This field is optional.
": "{Boolean}",AllowAutomatedFlows
Whether this event type can be used in an automated flow.
Default value: False
This field is optional.
": "{Boolean}",Name
Required/mandatory field
Name of the rambase event type. This should be more human readable than eventtype.
": "{String}",Namespace
Namespace of the rambase event type
This field is optional.
": "{String}",ObjectDetailsUri
API location for where to find more information about the object this event occurred for. May contains placeholders from with reference to parameter names. The parameter names are case sensitive.
This field is optional.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RamBaseEventTypeId
RamBase event type identifier
>{Integer}</RamBaseEventTypeId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Key
Key of the Event Type. This key will be used to identify which event to fire.
>{String}</Key>Name
Name of the rambase event type. This should be more human readable than eventtype.
>{String}</Name>Namespace
Namespace of the rambase event type
>{String}</Namespace>AllowWebhooks
If the Event Type can be used to create webhooks
>{Boolean}</AllowWebhooks>AllowAutomatedFlows
Whether this event type can be used in an automated flow.
>{Boolean}</AllowAutomatedFlows>Description
Description of the Event Type
>{String}</Description>ObjectDetailsUri
API location for where to find more information about the object this event occurred for. May contains placeholders from with reference to parameter names. The parameter names are case sensitive.
>Scope
Scope of the Duty
>{String}</Scope>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
>{Boolean}</IsPendingDeployment>RamBaseEventTypeId
RamBase event type identifier
": "{Integer}",Status
Status of the Event Type
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",Key
Key of the Event Type. This key will be used to identify which event to fire.
": "{String}",Name
Name of the rambase event type. This should be more human readable than eventtype.
": "{String}",Namespace
Namespace of the rambase event type
": "{String}",AllowWebhooks
If the Event Type can be used to create webhooks
": "{Boolean}",AllowAutomatedFlows
Whether this event type can be used in an automated flow.
": "{Boolean}",Description
Description of the Event Type
": "{String}",ObjectDetailsUri
API location for where to find more information about the object this event occurred for. May contains placeholders from with reference to parameter names. The parameter names are case sensitive.
": {Scope
Scope of the Duty
": "{String}",IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
": "{Boolean}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 102559 HTTP 400 | It not allowed to update in this status |
| Error 102560 HTTP 400 | Event type can not be "blank" |
| Error 102561 HTTP 400 | Event type already exist on another RamBase event type |